Skip to main content
Version: 1.0.0

Membership API

Membership API Overview

The Membership API allows authenticated applications to access user profile details securely. It provides endpoints for retrieving information about a member, including their account status, display name, and other profile-related attributes.

Table of Contents

Introduction

The Membership API is designed for developers integrating user profiles into their applications. It provides a way to authenticate users and retrieve essential profile information such as their ID, display name, and membership-related data.

This API enables seamless user management and integration with external platforms while ensuring secure access control.

Authentication

All requests to the Membership API require authentication using OAuth. The Authorization header must include a valid OAuth Bearer token obtained during the login flow.

Example Authorization Header:

Authorization: Bearer {your-oauth-token}

Error Handling

The API returns standard HTTP status codes to indicate success or failure.

  • 401: Unauthorized - The request is missing a valid OAuth token or authentication has failed.
  • 404: Not Found - The requested user profile does not exist.
  • 500: Internal Server Error - An unexpected error occurred on the server.

Example Application

The Maze Game authenticates users and displays authenticated user profiles using the Public Membership API. This allows the Maze Game to personalize their logged in user experience with user profile pictures and display names from Tribally!

Authentication​

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer